Skip to content

[chore] Add event's to the namespace registry #2382 #2464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Jul 2, 2025

Progresses #2382

Changes

This introduces events to the registry so that they can reside alongside the entities registry. This provides pure code generated documentation for events which reduces maintenance effort and makes things more discoverable.

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

@thompson-tomo thompson-tomo requested a review from a team as a code owner July 2, 2025 05:11
@thompson-tomo thompson-tomo requested review from a team as code owners July 2, 2025 05:11
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 3 times, most recently from 06aaa4a to d1c802d Compare July 2, 2025 06:13
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 5 times, most recently from dc0d7d5 to 9414d75 Compare July 12, 2025 08:35
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from 9414d75 to e21445d Compare July 12, 2025 08:39
@jsuereth
Copy link
Contributor

A few thoughts on this:

  • Can you comment on why each event is its own markdown file? I think this is likely the right way forward but want to be explicit as we move forward on signals. It is not what we did for Entity.
  • Can you add a link to the Event registry from the registry/README.md file?
  • Can you modify this to pull in every event without using startswith. I think you had at one time split logrecord vs. event. We do not want that distinction going forward, so this should just grab all group.type=event.

@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Jul 14, 2025

Thanks for the feedback @jsuereth

Can you comment on why each event is its own markdown file? I think this is likely the right way forward but want to be explicit as we move forward on signals. It is not what we did for Entity.

Reason for 1 page per signal definition is so that we could have a namespace index page which would hopefully list everything in that namespace be it events, log records, metrics, spans etc. If we have 1 page it quickly grows out of hand and this approach is inline with the proposal to update the metric layout.

Can you add a link to the Event registry from the registry/README.md file?

Yes can do

Can you modify this to pull in every event without using startswith. I think you had at one time split logrecord vs. event. We do not want that distinction going forward, so this should just grab all group.type=event.

If possible I would get rid of the starts with altogether and just do filtering on the last mapping and is what is required for the general namespace page.

@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Jul 14, 2025

@jsuereth Following on from the semconv meeting, I will do the following:

  • Raise a seperate pr to introduce the namespace index page as seen here so it can be used for entities.
  • Add entities to the namespace index page & dedicated pages
  • Allow this PR to focus on adding events to the registry
  • Work through existing event pages inspecting what has been migrated

@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from 8e344c3 to fe145fd Compare July 15, 2025 02:34
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from fe145fd to 996f804 Compare July 15, 2025 02:37
@thompson-tomo thompson-tomo requested review from a team as code owners July 15, 2025 03:12
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 2 times, most recently from da3f7a1 to 8616dc2 Compare July 15, 2025 03:29
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from 8616dc2 to 1240a6d Compare July 15, 2025 03:41
@thompson-tomo thompson-tomo requested a review from a team as a code owner July 15, 2025 03:41
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 4 times, most recently from 42a3207 to f517fd3 Compare July 15, 2025 04:02
@thompson-tomo thompson-tomo requested a review from a team as a code owner July 15, 2025 04:02
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from f517fd3 to af5ee03 Compare July 15, 2025 04:04

## Gen AI Assistant Message

**Status:** ![Development](https://img.shields.io/badge/-development-blue)
Copy link
Contributor

@lmolkova lmolkova Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this (and all other gen_ai) event is not really usable without the rest of the GenAI convention it follows at least today

To make the usable:

  1. we need to express event requirement level in the yaml.
  2. find a way to link from here to the actual convention which consist of a group of events, spans and metrics.
  3. Find ways to bring these notes https://github.com/thompson-tomo/semantic-conventions/blob/42a320708d1a5bbdaad4cb955765b8f9ef926d24/docs/gen-ai/gen-ai-events.md?plain=1#L20-L39 - without them someone who discovers this even without the convention might not know how to migrate.

When it comes to GenAI events, I don't see how event registry is helpful. It breaks coherent document in multiple pieces without solving any problem.

Copy link
Contributor Author

@thompson-tomo thompson-tomo Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to express event requirement level in the yaml.

There is already a weaver issue for this open-telemetry/weaver#406

find a way to link from here to the actual convention which consist of a group of events, spans and metrics.

When #2518 is merged in the template used can add a link to the namespace page (currently commented out). Hence solving this. Also Grouping ties into open-telemetry/weaver#406

Find ways to bring these notes https://github.com/thompson-tomo/semantic-conventions/blob/42a320708d1a5bbdaad4cb955765b8f9ef926d24/docs/gen-ai/gen-ai-events.md?plain=1#L20-L39 - without them someone who discovers this even without the convention might not know how to migrate.

Agree and was already captured as open-telemetry/weaver#802

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we talk about the benefits we get from event registry in MD and moving event definitions away from the corresponding conventions?

Copy link
Contributor Author

@thompson-tomo thompson-tomo Jul 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

benefits we get from event registry in MD

I no longer see it as an event registry, originally I did when first raising PR. It is now adding events to the namespace registry alongside the other signals. The benefits would be things like readability, discoverability & consistency.

moving event definitions away from the corresponding conventions

This I don't get, when #2518 is merged you will have a single gen-ai page which is automatically generated which contains tables describing all of the events & entities which are defined. This will grow to include metrics, spans & attributes once their definitions can be fully defined in yaml and tooling can handle it.

What I do agree with is the way in which implementations are defined, can and should be improved. I will see if I can come with an interim solution for gen-ai.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The notion of namespace is not clear and I'd recommend prototyping and socializing the end result before working on any new proposals. I don't believe it's productive to work on it without getting feedback and buy-in from @open-telemetry/specs-semconv-approvers

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was actioning what was discussed in the last semconv meeting where it was socialized the end result of having a page showcasing the events available and being able to select one to see more details. It was explicitly mentioned that this index page would grow to include the other signals.

@thompson-tomo thompson-tomo marked this pull request as draft July 15, 2025 04:17
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 4 times, most recently from cf97d66 to 13ed1b2 Compare July 15, 2025 10:18
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from 13ed1b2 to a9453cc Compare July 15, 2025 10:32
@thompson-tomo thompson-tomo changed the title [chore] Create an event registry #2382 [chore] Add event's to the namespace registry #2382 Jul 16, 2025
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch 3 times, most recently from 82840f4 to d2d81ec Compare July 17, 2025 04:11
@thompson-tomo thompson-tomo force-pushed the feature/#2382_AddEventRegistry branch from d2d81ec to 6b5fd79 Compare July 17, 2025 04:14
@lmolkova lmolkova moved this from Untriaged to Draft in Semantic Conventions Triage Jul 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants